Skip to content

Make docs environment deterministic#41926

Merged
hmellor merged 3 commits intovllm-project:mainfrom
hmellor:deterministic-docs-install
May 8, 2026
Merged

Make docs environment deterministic#41926
hmellor merged 3 commits intovllm-project:mainfrom
hmellor:deterministic-docs-install

Conversation

@hmellor
Copy link
Copy Markdown
Member

@hmellor hmellor commented May 7, 2026

Docs builds have started timing out during the mkdocs build stage. Since we only have 4 docs builders available, this effectively reduces the number of builders available to other docs builds.

This PR:

  • Uses pip-compile for docs dependencies so that they are all pinned

This likely won't fix the timeouts, but implementing these best practises will make debugging easier.

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Copy link
Copy Markdown

@claude claude Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented May 7, 2026

Documentation preview: https://vllm--41926.org.readthedocs.build/en/41926/

@mergify mergify Bot added documentation Improvements or additions to documentation ci/build labels May 7, 2026
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request modernizes the documentation build pipeline by transitioning to uv for dependency management, adding a pre-commit hook for compiling requirements, and simplifying the ReadTheDocs configuration. However, two critical issues were identified: the specified Python platform in the pre-commit configuration targets a glibc version incompatible with the ReadTheDocs environment, and the autogenerated requirements/docs.txt contains invalid, future-dated package versions that will cause installation failures.

Comment thread .pre-commit-config.yaml Outdated
Comment thread requirements/docs.txt
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
@hmellor
Copy link
Copy Markdown
Member Author

hmellor commented May 7, 2026

I've reverted the uv stuff because it causes readthedocs to try and use uv run mkdocs build, and uv run sees vLLM's pyproject.toml and tries to install it

@hmellor hmellor enabled auto-merge (squash) May 8, 2026 09:27
@github-actions github-actions Bot added the ready ONLY add when PR is ready to merge/full CI is needed label May 8, 2026
@hmellor hmellor merged commit 630820a into vllm-project:main May 8, 2026
14 checks passed
@hmellor hmellor deleted the deterministic-docs-install branch May 8, 2026 10:13
libinta pushed a commit to libinta/vllm that referenced this pull request May 8, 2026
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Libin Tang <libin.tang@intel.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci/build documentation Improvements or additions to documentation ready ONLY add when PR is ready to merge/full CI is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants